API

Procurement APIs

GET procurement/credit-notes/{supplierCreditNoteId}

Supplier credit note details for provided identifier

HTTP method GET
URI https://api.rambase.net/procurement/credit-notes/{supplierCreditNoteId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {supplierCreditNoteId} Supplier credit note identifier
Integer, minimum 100000
Custom fields Custom fields supported
Successful HTTP status code 200
API resource identifier 632, version 30

The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold are required/mandatory.

Format:
1
1

The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.

$showDomainDescriptions Boolean, optional Set to "true" to include domain descriptions for fields using domain values. See the Domain values page for more information. Default value is false.
$lang String, optional Specifies the language used in the response, following the 3-letter ISO-639-1 [lll]
$access_token String, optional After successful login you get an access token which needs to be provided in all API requests. Even though it is possible to pass this token as query parameter, we recommended passing it using the HTTP request header as described in Authorization. Note that all access tokens have an expiration time.
$db String, optional Set the database/company for the request
$format String, optional Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json"
$useMinimumVersion Integer, optional Used to run a new version of an API resource when your API client is running a deprecated API resource. See the Breaking changes page for more information.
$select String, optional Use to define the fields to return in the response. Accepts a comma-separated list of field names. See the Expand and select page for more information.
$expand String, optional Use to include output fields that are not returned by default in the response. Accepts a comma-separated list of expandable field names. See the Expand and Select page for more information.
$showCustomFields Boolean, optional Set to "true" to include custom fields. Default value is false.

Read more about filters and sorting on how to use filter parameters and named filters.

Read more about filters and sorting on how to use sortable parameters

Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields. Fields colored in grey is expandable fields.

Please note that some fields may be removed from the response, based on user roles/duties/permissions.

Format:
1
<SupplierCreditNote>
2
     <SupplierCreditNoteId
SupplierCreditNoteId

Supplier credit note identifier

>{Integer}</SupplierCreditNoteId>
3
     <Status
Status

Status of supplier credit note

Possible domain values can be found here

>{String}</Status>
4
     <CreatedAt
CreatedAt

Date and time of creation

>{Datetime}</CreatedAt>
5
     <SuppliersReference
SuppliersReference

Suppliers/sellers reference. Typically a person.

>{String}</SuppliersReference>
6
     <SuppliersInvoiceNumber
SuppliersInvoiceNumber

Suppliers/sellers reference number. Typically to an external system.

>{String}</SuppliersInvoiceNumber>
7
     <SuppliersPaymentReference
SuppliersPaymentReference

Sellers reference to identify the object. In Norway this is typically a KID-number.

>{String}</SuppliersPaymentReference>
8
     <BuyersReferenceNumber
BuyersReferenceNumber

Buyers reference number

>{String}</BuyersReferenceNumber>
9
     <IssueDate
IssueDate

Date when the document was issued.

>{Date}</IssueDate>
10
     <ReceivedDate
ReceivedDate

Date when the document was received.

>{Date}</ReceivedDate>
11
     <RegistrationDate
RegistrationDate

Date of registration

>{Date}</RegistrationDate>
12
     <Currency
Currency

Three character code following the ISO 4217 standard

Possible domain values can be found here

>{String}</Currency>
13
     <Note
Note

Additional information regarding the object (free text). This note might be visible to customers/suppliers.

>{String}</Note>
14
     <PendingReception
PendingReception

Indicates if the supplier credit note is pending reception

>{Boolean}</PendingReception>
15
     <NumberOfAttachements
NumberOfAttachements

Number of attachements for this supplier credit note

This field is greyed out because it is an expandable field. You have to add $expand=NumberOfAttachements in your request URI to get this field

>{Integer}</NumberOfAttachements>
16
     <ShipToAttention
ShipToAttention

Attention of the ship to address. When changing ship to address, the ShipToAttention will be overridden by the attention of the new ship to address.

>{String}</ShipToAttention>
17
     <InvoiceAddressAttention
InvoiceAddressAttention

Attention of the correspondence address. When changing correspondence address, the CorrespondenceAddressAttention will be overridden by the attention of the new correspondence address.

>{String}</InvoiceAddressAttention>
18
     <PolishRequirements
PolishRequirements

This field is greyed out because it is an expandable field. You have to add $expand=PolishRequirements in your request URI to get this field

>
19
          <IsSubjectedToSplitPayment
IsSubjectedToSplitPayment

Indicates if an customer / supplier invoice and / or credit note is subjected to split payment

This field is greyed out because it is an expandable field. You have to add $expand=PolishRequirements in your request URI to get this field

>{Boolean}</IsSubjectedToSplitPayment>
20
          <PurchaseOutsideEU
PurchaseOutsideEU

Purchase was from outside of EU. Used for the JPK files for "Shortened import procedure outside of EU".

This field is greyed out because it is an expandable field. You have to add $expand=PolishRequirements in your request URI to get this field

>{Boolean}</PurchaseOutsideEU>
21
     </PolishRequirements>
22
     <AccountingPeriod>
23
          <AccountingPeriodId
AccountingPeriodId

Accounting period identifier

>{Integer}</AccountingPeriodId>
24
          <Period
Period

Accounting period

>{Integer}</Period>
25
          <AccountingPeriodLink
AccountingPeriodLink

Accounting period reference

>{String}</AccountingPeriodLink>
26
     </AccountingPeriod>
27
     <Location>
28
          <LocationId
LocationId

Location identifier

>{Integer}</LocationId>
29
          <Name
Name

Name of location

>{String}</Name>
30
          <ShortName
ShortName

Unique abbreviation/short name of the location

>{String}</ShortName>
31
          <LocationLink
LocationLink

Location reference

>{String}</LocationLink>
32
     </Location>
33
     <Assignee
Assignee

The user who has been assigned to work with this object.

>
34
          <UserId
UserId

User identifier

>{Integer}</UserId>
35
          <Name
Name

Name of the user

>{String}</Name>
36
          <FirstName
FirstName

First name of the user

>{String}</FirstName>
37
          <UserLink
UserLink

User reference

>{String}</UserLink>
38
     </Assignee>
39
     <Supplier>
40
          <SupplierId
SupplierId

RamBase supplier identifier

>{Integer}</SupplierId>
41
          <Name
Name

Name of supplier (name of company or surname/familyname/lastname of a person)

>{String}</Name>
42
          <Firstname
Firstname

Firstname/givenname if the supplier is a person

>{String}</Firstname>
43
          <Phone
Phone

Main phone number of the supplier

This field is greyed out because it is an expandable field. You have to add $expand=Supplier.Phone in your request URI to get this field

>{String}</Phone>
44
          <Email
Email

Main email address to the supplier

This field is greyed out because it is an expandable field. You have to add $expand=Supplier.Email in your request URI to get this field

>{String}</Email>
45
          <LegalEntityIdentifier
LegalEntityIdentifier

The suppliers unique enterprise/organization number.

>{String}</LegalEntityIdentifier>
46
          <VATRegistrationNumber
VATRegistrationNumber

Unique number assigned by the relevant tax authority to identify a party for use in relation to value added tax (VAT).

>{String}</VATRegistrationNumber>
47
          <Intercompany>
48
               <Code
Code

Intercompany database the supplier belongs to.

>{String}</Code>
49
          </Intercompany>
50
          <Invoicing
Invoicing

This field is greyed out because it is an expandable field. You have to add $expand=Supplier.Invoicing in your request URI to get this field

>
51
               <DefaultInvoiceAddress
DefaultInvoiceAddress

This field is greyed out because it is an expandable field. You have to add $expand=Supplier.Invoicing in your request URI to get this field

>
52
                    <AddressLine1
AddressLine1

First address line

This field is greyed out because it is an expandable field. You have to add $expand=Supplier.Invoicing in your request URI to get this field

>{String}</AddressLine1>
53
                    <AddressLine2
AddressLine2

Second address line

This field is greyed out because it is an expandable field. You have to add $expand=Supplier.Invoicing in your request URI to get this field

>{String}</AddressLine2>
54
                    <PostalCode
PostalCode

Postalcode/Postcode/ZIP

This field is greyed out because it is an expandable field. You have to add $expand=Supplier.Invoicing in your request URI to get this field

>{String}</PostalCode>
55
                    <City
City

City/town/village

This field is greyed out because it is an expandable field. You have to add $expand=Supplier.Invoicing in your request URI to get this field

>{String}</City>
56
                    <Region
Region

Region/province/state

This field is greyed out because it is an expandable field. You have to add $expand=Supplier.Invoicing in your request URI to get this field

>{String}</Region>
57
                    <CountryCode
CountryCode

Two-character code (ISO 3166) identifying the country.

This field is greyed out because it is an expandable field. You have to add $expand=Supplier.Invoicing in your request URI to get this field

>{String}</CountryCode>
58
                    <Country
Country

English name of country.

This field is greyed out because it is an expandable field. You have to add $expand=Supplier.Invoicing in your request URI to get this field

>{String}</Country>
59
               </DefaultInvoiceAddress>
60
          </Invoicing>
61
          <SupplierLink
SupplierLink

Supplier reference

>{String}</SupplierLink>
62
     </Supplier>
63
     <SupplierBankAccount>
64
          <SupplierBankAccountId
SupplierBankAccountId

Supplier bank account identifier

>{Integer}</SupplierBankAccountId>
65
          <Name
Name

Name of bank account

>{String}</Name>
66
          <AccountNumber
AccountNumber

Account number used to identify the bank account

>{String}</AccountNumber>
67
          <Bank>
68
               <SWIFTCode
SWIFTCode

The SWIFT (Society for Worldwide Interbank Financial Telecommunication) Code is a standard format for Business Identifier Codes (BIC) and it's used to uniquely identify banks and financial institutions globally. These codes are used when transferring money between banks, in particular for international wire transfers or SEPA payments.

>{String}</SWIFTCode>
69
               <InternationalBankAccountNumber
InternationalBankAccountNumber

The International Bank Account Number (IBAN) is an internationally agreed means of identifying bank accounts across national borders with a reduced risk of transcription errors.

>{String}</InternationalBankAccountNumber>
70
               <Address
Address

Address of the bank associated with the bank account

>
71
                    <CountryCode
CountryCode

Two-character code (ISO 3166) identifying the country.

>{String}</CountryCode>
72
               </Address>
73
          </Bank>
74
          <SupplierBankAccountLink
SupplierBankAccountLink

Supplier bank account reference

>{String}</SupplierBankAccountLink>
75
     </SupplierBankAccount>
76
     <Totals>
77
          <Currency
Currency

Three character code following the ISO 4217 standard

>{String}</Currency>
78
          <FreightAmount
FreightAmount

Freight amount in transaction document's currency

>{Decimal}</FreightAmount>
79
          <FeeAmount
FeeAmount

Fee amount in transaction document's currency

>{Decimal}</FeeAmount>
80
          <RoundOffAmount
RoundOffAmount

Round-off amount in transaction document's currency

>{Decimal}</RoundOffAmount>
81
          <SubTotalAmount
SubTotalAmount

Total amount of the object in object currency, excluding VAT.

>{Decimal}</SubTotalAmount>
82
          <VATAmount
VATAmount

Total value added tax in object currency.

>{Decimal}</VATAmount>
83
          <TotalAmount
TotalAmount

The total amount in object currency, including VAT

>{Decimal}</TotalAmount>
84
          <VATRoundOffAmount
VATRoundOffAmount

VAT round-off amount in transaction document's currency

>{Decimal}</VATRoundOffAmount>
85
     </Totals>
86
     <TotalsConverted
TotalsConverted

This field is greyed out because it is an expandable field. You have to add $expand=TotalsConverted in your request URI to get this field

>
87
          <Currency
Currency

Currency used in conversion. Default is company accounting currency. Three character code following the ISO 4217 standard.

This field is greyed out because it is an expandable field. You have to add $expand=TotalsConverted in your request URI to get this field

>{String}</Currency>
88
          <ExchangeRate
ExchangeRate

The exchange rate used in convertion

This field is greyed out because it is an expandable field. You have to add $expand=TotalsConverted in your request URI to get this field

>{Decimal}</ExchangeRate>
89
          <FreightAmount
FreightAmount

Freight amount in company currency.

This field is greyed out because it is an expandable field. You have to add $expand=TotalsConverted in your request URI to get this field

>{Decimal}</FreightAmount>
90
          <FeeAmount
FeeAmount

Fee amount in company currency

This field is greyed out because it is an expandable field. You have to add $expand=TotalsConverted in your request URI to get this field

>{Decimal}</FeeAmount>
91
          <RoundOffAmount
RoundOffAmount

Round-off amount in company currency

This field is greyed out because it is an expandable field. You have to add $expand=TotalsConverted in your request URI to get this field

>{Decimal}</RoundOffAmount>
92
          <SubTotalAmount
SubTotalAmount

Total amount of the object in company currency, excluding VAT.

This field is greyed out because it is an expandable field. You have to add $expand=TotalsConverted in your request URI to get this field

>{Decimal}</SubTotalAmount>
93
          <VATAmount
VATAmount

Value added tax amount in company currency.

This field is greyed out because it is an expandable field. You have to add $expand=TotalsConverted in your request URI to get this field

>{Decimal}</VATAmount>
94
          <TotalAmount
TotalAmount

The total amount in company currency, including VAT.

This field is greyed out because it is an expandable field. You have to add $expand=TotalsConverted in your request URI to get this field

>{Decimal}</TotalAmount>
95
          <VATRoundOffAmount
VATRoundOffAmount

VAT round-off amount in company currency

This field is greyed out because it is an expandable field. You have to add $expand=TotalsConverted in your request URI to get this field

>{Decimal}</VATRoundOffAmount>
96
     </TotalsConverted>
97
     <ShipTo>
98
          <Name
Name

Name of receiver (Name of company or last name of a person). Note that default invoice address must have the same name as the customer.

>{String}</Name>
99
          <Firstname
Firstname

Firstname if the receiver is a person. Note that default invoice address must have the same firstname as the customer.

>{String}</Firstname>
100
          <AddressLine1
AddressLine1

First address line

>{String}</AddressLine1>
101
          <AddressLine2
AddressLine2

Second address line

>{String}</AddressLine2>
102
          <PostalCode
PostalCode

Postalcode/Postcode/ZIP

>{String}</PostalCode>
103
          <City
City

City/town/village

>{String}</City>
104
          <Region
Region

Region/province/state

>{String}</Region>
105
          <CountryCode
CountryCode

Two-character code (ISO 3166) identifying the country.

>{String}</CountryCode>
106
          <Country
Country

English name of country.

>{String}</Country>
107
          <Reference>
108
               <Database
Database

Database of the object

>{String}</Database>
109
               <ItemId
ItemId

Item-number of the object

>{Integer}</ItemId>
110
               <ItemType
ItemType

Type of item

>{String}</ItemType>
111
               <ItemLink
ItemLink

API reference to the item

>{String}</ItemLink>
112
               <ObjectId
ObjectId

Identifier of the object

>{Integer}</ObjectId>
113
               <ObjectType
ObjectType

Type of object

>{String}</ObjectType>
114
               <ObjectLink
ObjectLink

API reference to the object

>{String}</ObjectLink>
115
               <RamBaseKey
RamBaseKey

Internal RamBase identifier of the object/item

>{String}</RamBaseKey>
116
          </Reference>
117
     </ShipTo>
118
     <ShipFrom>
119
          <AddressId
AddressId

Address identifier

>{Integer}</AddressId>
120
          <Name
Name

Name of receiver (Name of company or last name of a person). Note that default invoice address must have the same name as the customer.

>{String}</Name>
121
          <AddressLine1
AddressLine1

First address line

>{String}</AddressLine1>
122
          <AddressLine2
AddressLine2

Second address line

>{String}</AddressLine2>
123
          <PostalCode
PostalCode

Postalcode/Postcode/ZIP

>{String}</PostalCode>
124
          <City
City

City/town/village

>{String}</City>
125
          <Region
Region

Region/province/state

>{String}</Region>
126
          <CountryCode
CountryCode

Two-character code (ISO 3166) identifying the country.

>{String}</CountryCode>
127
          <Country
Country

English name of country.

>{String}</Country>
128
          <AddressLink
AddressLink

Supplier address reference

>{String}</AddressLink>
129
     </ShipFrom>
130
     <Payment>
131
          <PaymentTerms
PaymentTerms

Terms of payment. Defaut value is retrieved from the supplier.

Possible domain values can be found here

>{String}</PaymentTerms>
132
          <PaymentMethod
PaymentMethod

Method of payment. Default value is retrieved from the supplier.

Possible domain values can be found here

>{String}</PaymentMethod>
133
          <DueDate
DueDate

Date the object is due to be paid

>{Date}</DueDate>
134
     </Payment>
135
     <VATDetails>
136
          <PostponeVAT
PostponeVAT

Indicates that the VAT posting should be postponed

>{Boolean}</PostponeVAT>
137
          <VATType
VATType

Type of value added tax

>{String}</VATType>
138
          <VATHandling
VATHandling

Specifies how value added tax (VAT) should be calculated. Either always include VAT, always exclude VAT or use standard/default VAT rules.

Possible domain values can be found here

>{String}</VATHandling>
139
          <VATRate
VATRate

Rate between transaction currency and company VAT currency. VAT rate should be used to calculate VAT amount in company VAT currency.

>{Decimal}</VATRate>
140
          <VATDate
VATDate

Date of VAT posting. Currency rate calculation use this date.

>{Date}</VATDate>
141
          <VATPeriod
VATPeriod

Accounting period this VAT posting belongs to

>{Integer}</VATPeriod>
142
          <DefaultVATPercent
DefaultVATPercent

Value added tax percent.

>{Decimal}</DefaultVATPercent>
143
          <DefaultVATCodeDefinition>
144
               <VATCodeDefinitionId
VATCodeDefinitionId

VAT code identifier

>{Integer}</VATCodeDefinitionId>
145
               <VATCode
VATCode

Code that determines VAT rules used for VAT calculations.

>{String}</VATCode>
146
               <Description
Description

Description of VAT Code definition

>{String}</Description>
147
               <VATCodeDefinitionLink
VATCodeDefinitionLink

VAT code reference

>{String}</VATCodeDefinitionLink>
148
          </DefaultVATCodeDefinition>
149
          <VATEntity>
150
               <VATRegistrationNumber
VATRegistrationNumber

Unique number assigned by the relevant tax authority to identify a party for use in relation to value added tax (VAT)

>{String}</VATRegistrationNumber>
151
               <Currency
Currency

Three character code following the ISO 4217 standard

>{String}</Currency>
152
               <Country
Country

Country name of VAT entity

>{String}</Country>
153
               <CountryCode
CountryCode

Country code of VAT Entity

>{String}</CountryCode>
154
          </VATEntity>
155
     </VATDetails>
156
     <HighlightedNotification
HighlightedNotification

This field is greyed out because it is an expandable field. You have to add $expand=HighlightedNotification in your request URI to get this field

>
157
          <NotificationId
NotificationId

Notification identifier

This field is greyed out because it is an expandable field. You have to add $expand=HighlightedNotification in your request URI to get this field

>{Integer}</NotificationId>
158
          <Status
Status

Status of the notification

This field is greyed out because it is an expandable field. You have to add $expand=HighlightedNotification in your request URI to get this field

>{Integer}</Status>
159
          <CreatedAt
CreatedAt

Date and time of creation

This field is greyed out because it is an expandable field. You have to add $expand=HighlightedNotification in your request URI to get this field

>{Datetime}</CreatedAt>
160
          <Message
Message

The message from the notification definition, expanded with parameters.

This field is greyed out because it is an expandable field. You have to add $expand=HighlightedNotification in your request URI to get this field

>{String}</Message>
161
          <TranslatedMessage
TranslatedMessage

The translated message from the notification definition, expanded with parameters.

This field is greyed out because it is an expandable field. You have to add $expand=HighlightedNotification in your request URI to get this field

>{String}</TranslatedMessage>
162
          <NotificationType
NotificationType

This field is greyed out because it is an expandable field. You have to add $expand=HighlightedNotification in your request URI to get this field

>
163
               <NotificationTypeId
NotificationTypeId

Notification type identifier

This field is greyed out because it is an expandable field. You have to add $expand=HighlightedNotification in your request URI to get this field

>{String}</NotificationTypeId>
164
               <Category
Category

Category of notification type (warning, information etc)

Possible domain values can be found here

This field is greyed out because it is an expandable field. You have to add $expand=HighlightedNotification in your request URI to get this field

>{String}</Category>
165
               <NotificationTypeLink
NotificationTypeLink

Notification type reference

This field is greyed out because it is an expandable field. You have to add $expand=HighlightedNotification in your request URI to get this field

>{String}</NotificationTypeLink>
166
          </NotificationType>
167
          <NotificationLink
NotificationLink

Notification reference

This field is greyed out because it is an expandable field. You have to add $expand=HighlightedNotification in your request URI to get this field

>{String}</NotificationLink>
168
     </HighlightedNotification>
169
</SupplierCreditNote>
1
{
2
     "supplierCreditNote": {
3
          "supplierCreditNoteId
SupplierCreditNoteId

Supplier credit note identifier

": "{Integer}",
4
          "status
Status

Status of supplier credit note

Possible domain values can be found here

": "{String}",
5
          "createdAt
CreatedAt

Date and time of creation

": "{Datetime}",
6
          "suppliersReference
SuppliersReference

Suppliers/sellers reference. Typically a person.

": "{String}",
7
          "suppliersInvoiceNumber
SuppliersInvoiceNumber

Suppliers/sellers reference number. Typically to an external system.

": "{String}",
8
          "suppliersPaymentReference
SuppliersPaymentReference

Sellers reference to identify the object. In Norway this is typically a KID-number.

": "{String}",
9
          "buyersReferenceNumber
BuyersReferenceNumber

Buyers reference number

": "{String}",
10
          "issueDate
IssueDate

Date when the document was issued.

": "{Date}",
11
          "receivedDate
ReceivedDate

Date when the document was received.

": "{Date}",
12
          "registrationDate
RegistrationDate

Date of registration

": "{Date}",
13
          "currency
Currency

Three character code following the ISO 4217 standard

Possible domain values can be found here

": "{String}",
14
          "note
Note

Additional information regarding the object (free text). This note might be visible to customers/suppliers.

": "{String}",
15
          "pendingReception
PendingReception

Indicates if the supplier credit note is pending reception

": "{Boolean}",
16
          "numberOfAttachements
NumberOfAttachements

Number of attachements for this supplier credit note

This field is greyed out because it is an expandable field. You have to add $expand=NumberOfAttachements in your request URI to get this field

": "{Integer}",
17
          "shipToAttention
ShipToAttention

Attention of the ship to address. When changing ship to address, the ShipToAttention will be overridden by the attention of the new ship to address.

": "{String}",
18
          "invoiceAddressAttention
InvoiceAddressAttention

Attention of the correspondence address. When changing correspondence address, the CorrespondenceAddressAttention will be overridden by the attention of the new correspondence address.

": "{String}",
19
          "polishRequirements
PolishRequirements

This field is greyed out because it is an expandable field. You have to add $expand=PolishRequirements in your request URI to get this field

": {
20
               "isSubjectedToSplitPayment
IsSubjectedToSplitPayment

Indicates if an customer / supplier invoice and / or credit note is subjected to split payment

This field is greyed out because it is an expandable field. You have to add $expand=PolishRequirements in your request URI to get this field

": "{Boolean}",
21
               "purchaseOutsideEU
PurchaseOutsideEU

Purchase was from outside of EU. Used for the JPK files for "Shortened import procedure outside of EU".

This field is greyed out because it is an expandable field. You have to add $expand=PolishRequirements in your request URI to get this field

": "{Boolean}"
22
          },
23
          "accountingPeriod": {
24
               "accountingPeriodId
AccountingPeriodId

Accounting period identifier

": "{Integer}",
25
               "period
Period

Accounting period

": "{Integer}",
26
               "accountingPeriodLink
AccountingPeriodLink

Accounting period reference

": "{String}"
27
          },
28
          "location": {
29
               "locationId
LocationId

Location identifier

": "{Integer}",
30
               "name
Name

Name of location

": "{String}",
31
               "shortName
ShortName

Unique abbreviation/short name of the location

": "{String}",
32
               "locationLink
LocationLink

Location reference

": "{String}"
33
          },
34
          "assignee
Assignee

The user who has been assigned to work with this object.

": {
35
               "userId
UserId

User identifier

": "{Integer}",
36
               "name
Name

Name of the user

": "{String}",
37
               "firstName
FirstName

First name of the user

": "{String}",
38
               "userLink
UserLink

User reference

": "{String}"
39
          },
40
          "supplier": {
41
               "supplierId
SupplierId

RamBase supplier identifier

": "{Integer}",
42
               "name
Name

Name of supplier (name of company or surname/familyname/lastname of a person)

": "{String}",
43
               "firstname
Firstname

Firstname/givenname if the supplier is a person

": "{String}",
44
               "phone
Phone

Main phone number of the supplier

This field is greyed out because it is an expandable field. You have to add $expand=Supplier.Phone in your request URI to get this field

": "{String}",
45
               "email
Email

Main email address to the supplier

This field is greyed out because it is an expandable field. You have to add $expand=Supplier.Email in your request URI to get this field

": "{String}",
46
               "legalEntityIdentifier
LegalEntityIdentifier

The suppliers unique enterprise/organization number.

": "{String}",
47
               "vATRegistrationNumber
VATRegistrationNumber

Unique number assigned by the relevant tax authority to identify a party for use in relation to value added tax (VAT).

": "{String}",
48
               "intercompany": {
49
                    "code
Code

Intercompany database the supplier belongs to.

": "{String}"
50
               },
51
               "invoicing
Invoicing

This field is greyed out because it is an expandable field. You have to add $expand=Supplier.Invoicing in your request URI to get this field

": {
52
                    "defaultInvoiceAddress
DefaultInvoiceAddress

This field is greyed out because it is an expandable field. You have to add $expand=Supplier.Invoicing in your request URI to get this field

": {
53
                         "addressLine1
AddressLine1

First address line

This field is greyed out because it is an expandable field. You have to add $expand=Supplier.Invoicing in your request URI to get this field

": "{String}",
54
                         "addressLine2
AddressLine2

Second address line

This field is greyed out because it is an expandable field. You have to add $expand=Supplier.Invoicing in your request URI to get this field

": "{String}",
55
                         "postalCode
PostalCode

Postalcode/Postcode/ZIP

This field is greyed out because it is an expandable field. You have to add $expand=Supplier.Invoicing in your request URI to get this field

": "{String}",
56
                         "city
City

City/town/village

This field is greyed out because it is an expandable field. You have to add $expand=Supplier.Invoicing in your request URI to get this field

": "{String}",
57
                         "region
Region

Region/province/state

This field is greyed out because it is an expandable field. You have to add $expand=Supplier.Invoicing in your request URI to get this field

": "{String}",
58
                         "countryCode
CountryCode

Two-character code (ISO 3166) identifying the country.

This field is greyed out because it is an expandable field. You have to add $expand=Supplier.Invoicing in your request URI to get this field

": "{String}",
59
                         "country
Country

English name of country.

This field is greyed out because it is an expandable field. You have to add $expand=Supplier.Invoicing in your request URI to get this field

": "{String}"
60
                    }
61
               },
62
               "supplierLink
SupplierLink

Supplier reference

": "{String}"
63
          },
64
          "supplierBankAccount": {
65
               "supplierBankAccountId
SupplierBankAccountId

Supplier bank account identifier

": "{Integer}",
66
               "name
Name

Name of bank account

": "{String}",
67
               "accountNumber
AccountNumber

Account number used to identify the bank account

": "{String}",
68
               "bank": {
69
                    "sWIFTCode
SWIFTCode

The SWIFT (Society for Worldwide Interbank Financial Telecommunication) Code is a standard format for Business Identifier Codes (BIC) and it's used to uniquely identify banks and financial institutions globally. These codes are used when transferring money between banks, in particular for international wire transfers or SEPA payments.

": "{String}",
70
                    "internationalBankAccountNumber
InternationalBankAccountNumber

The International Bank Account Number (IBAN) is an internationally agreed means of identifying bank accounts across national borders with a reduced risk of transcription errors.

": "{String}",
71
                    "address
Address

Address of the bank associated with the bank account

": {
72
                         "countryCode
CountryCode

Two-character code (ISO 3166) identifying the country.

": "{String}"
73
                    }
74
               },
75
               "supplierBankAccountLink
SupplierBankAccountLink

Supplier bank account reference

": "{String}"
76
          },
77
          "totals": {
78
               "currency
Currency

Three character code following the ISO 4217 standard

": "{String}",
79
               "freightAmount
FreightAmount

Freight amount in transaction document's currency

": "{Decimal}",
80
               "feeAmount
FeeAmount

Fee amount in transaction document's currency

": "{Decimal}",
81
               "roundOffAmount
RoundOffAmount

Round-off amount in transaction document's currency

": "{Decimal}",
82
               "subTotalAmount
SubTotalAmount

Total amount of the object in object currency, excluding VAT.

": "{Decimal}",
83
               "vATAmount
VATAmount

Total value added tax in object currency.

": "{Decimal}",
84
               "totalAmount
TotalAmount

The total amount in object currency, including VAT

": "{Decimal}",
85
               "vATRoundOffAmount
VATRoundOffAmount

VAT round-off amount in transaction document's currency

": "{Decimal}"
86
          },
87
          "totalsConverted
TotalsConverted

This field is greyed out because it is an expandable field. You have to add $expand=TotalsConverted in your request URI to get this field

": {
88
               "currency
Currency

Currency used in conversion. Default is company accounting currency. Three character code following the ISO 4217 standard.

This field is greyed out because it is an expandable field. You have to add $expand=TotalsConverted in your request URI to get this field

": "{String}",
89
               "exchangeRate
ExchangeRate

The exchange rate used in convertion

This field is greyed out because it is an expandable field. You have to add $expand=TotalsConverted in your request URI to get this field

": "{Decimal}",
90
               "freightAmount
FreightAmount

Freight amount in company currency.

This field is greyed out because it is an expandable field. You have to add $expand=TotalsConverted in your request URI to get this field

": "{Decimal}",
91
               "feeAmount
FeeAmount

Fee amount in company currency

This field is greyed out because it is an expandable field. You have to add $expand=TotalsConverted in your request URI to get this field

": "{Decimal}",
92
               "roundOffAmount
RoundOffAmount

Round-off amount in company currency

This field is greyed out because it is an expandable field. You have to add $expand=TotalsConverted in your request URI to get this field

": "{Decimal}",
93
               "subTotalAmount
SubTotalAmount

Total amount of the object in company currency, excluding VAT.

This field is greyed out because it is an expandable field. You have to add $expand=TotalsConverted in your request URI to get this field

": "{Decimal}",
94
               "vATAmount
VATAmount

Value added tax amount in company currency.

This field is greyed out because it is an expandable field. You have to add $expand=TotalsConverted in your request URI to get this field

": "{Decimal}",
95
               "totalAmount
TotalAmount

The total amount in company currency, including VAT.

This field is greyed out because it is an expandable field. You have to add $expand=TotalsConverted in your request URI to get this field

": "{Decimal}",
96
               "vATRoundOffAmount
VATRoundOffAmount

VAT round-off amount in company currency

This field is greyed out because it is an expandable field. You have to add $expand=TotalsConverted in your request URI to get this field

": "{Decimal}"
97
          },
98
          "shipTo": {
99
               "name
Name

Name of receiver (Name of company or last name of a person). Note that default invoice address must have the same name as the customer.

": "{String}",
100
               "firstname
Firstname

Firstname if the receiver is a person. Note that default invoice address must have the same firstname as the customer.

": "{String}",
101
               "addressLine1
AddressLine1

First address line

": "{String}",
102
               "addressLine2
AddressLine2

Second address line

": "{String}",
103
               "postalCode
PostalCode

Postalcode/Postcode/ZIP

": "{String}",
104
               "city
City

City/town/village

": "{String}",
105
               "region
Region

Region/province/state

": "{String}",
106
               "countryCode
CountryCode

Two-character code (ISO 3166) identifying the country.

": "{String}",
107
               "country
Country

English name of country.

": "{String}",
108
               "reference": {
109
                    "database
Database

Database of the object

": "{String}",
110
                    "itemId
ItemId

Item-number of the object

": "{Integer}",
111
                    "itemType
ItemType

Type of item

": "{String}",
112
                    "itemLink
ItemLink

API reference to the item

": "{String}",
113
                    "objectId
ObjectId

Identifier of the object

": "{Integer}",
114
                    "objectType
ObjectType

Type of object

": "{String}",
115
                    "objectLink
ObjectLink

API reference to the object

": "{String}",
116
                    "ramBaseKey
RamBaseKey

Internal RamBase identifier of the object/item

": "{String}"
117
               }
118
          },
119
          "shipFrom": {
120
               "addressId
AddressId

Address identifier

": "{Integer}",
121
               "name
Name

Name of receiver (Name of company or last name of a person). Note that default invoice address must have the same name as the customer.

": "{String}",
122
               "addressLine1
AddressLine1

First address line

": "{String}",
123
               "addressLine2
AddressLine2

Second address line

": "{String}",
124
               "postalCode
PostalCode

Postalcode/Postcode/ZIP

": "{String}",
125
               "city
City

City/town/village

": "{String}",
126
               "region
Region

Region/province/state

": "{String}",
127
               "countryCode
CountryCode

Two-character code (ISO 3166) identifying the country.

": "{String}",
128
               "country
Country

English name of country.

": "{String}",
129
               "addressLink
AddressLink

Supplier address reference

": "{String}"
130
          },
131
          "payment": {
132
               "paymentTerms
PaymentTerms

Terms of payment. Defaut value is retrieved from the supplier.

Possible domain values can be found here

": "{String}",
133
               "paymentMethod
PaymentMethod

Method of payment. Default value is retrieved from the supplier.

Possible domain values can be found here

": "{String}",
134
               "dueDate
DueDate

Date the object is due to be paid

": "{Date}"
135
          },
136
          "vATDetails": {
137
               "postponeVAT
PostponeVAT

Indicates that the VAT posting should be postponed

": "{Boolean}",
138
               "vATType
VATType

Type of value added tax

": "{String}",
139
               "vATHandling
VATHandling

Specifies how value added tax (VAT) should be calculated. Either always include VAT, always exclude VAT or use standard/default VAT rules.

Possible domain values can be found here

": "{String}",
140
               "vATRate
VATRate

Rate between transaction currency and company VAT currency. VAT rate should be used to calculate VAT amount in company VAT currency.

": "{Decimal}",
141
               "vATDate
VATDate

Date of VAT posting. Currency rate calculation use this date.

": "{Date}",
142
               "vATPeriod
VATPeriod

Accounting period this VAT posting belongs to

": "{Integer}",
143
               "defaultVATPercent
DefaultVATPercent

Value added tax percent.

": "{Decimal}",
144
               "defaultVATCodeDefinition": {
145
                    "vATCodeDefinitionId
VATCodeDefinitionId

VAT code identifier

": "{Integer}",
146
                    "vATCode
VATCode

Code that determines VAT rules used for VAT calculations.

": "{String}",
147
                    "description
Description

Description of VAT Code definition

": "{String}",
148
                    "vATCodeDefinitionLink
VATCodeDefinitionLink

VAT code reference

": "{String}"
149
               },
150
               "vATEntity": {
151
                    "vATRegistrationNumber
VATRegistrationNumber

Unique number assigned by the relevant tax authority to identify a party for use in relation to value added tax (VAT)

": "{String}",
152
                    "currency
Currency

Three character code following the ISO 4217 standard

": "{String}",
153
                    "country
Country

Country name of VAT entity

": "{String}",
154
                    "countryCode
CountryCode

Country code of VAT Entity

": "{String}"
155
               }
156
          },
157
          "highlightedNotification
HighlightedNotification

This field is greyed out because it is an expandable field. You have to add $expand=HighlightedNotification in your request URI to get this field

": {
158
               "notificationId
NotificationId

Notification identifier

This field is greyed out because it is an expandable field. You have to add $expand=HighlightedNotification in your request URI to get this field

": "{Integer}",
159
               "status
Status

Status of the notification

This field is greyed out because it is an expandable field. You have to add $expand=HighlightedNotification in your request URI to get this field

": "{Integer}",
160
               "createdAt
CreatedAt

Date and time of creation

This field is greyed out because it is an expandable field. You have to add $expand=HighlightedNotification in your request URI to get this field

": "{Datetime}",
161
               "message
Message

The message from the notification definition, expanded with parameters.

This field is greyed out because it is an expandable field. You have to add $expand=HighlightedNotification in your request URI to get this field

": "{String}",
162
               "translatedMessage
TranslatedMessage

The translated message from the notification definition, expanded with parameters.

This field is greyed out because it is an expandable field. You have to add $expand=HighlightedNotification in your request URI to get this field

": "{String}",
163
               "notificationType
NotificationType

This field is greyed out because it is an expandable field. You have to add $expand=HighlightedNotification in your request URI to get this field

": {
164
                    "notificationTypeId
NotificationTypeId

Notification type identifier

This field is greyed out because it is an expandable field. You have to add $expand=HighlightedNotification in your request URI to get this field

": "{String}",
165
                    "category
Category

Category of notification type (warning, information etc)

Possible domain values can be found here

This field is greyed out because it is an expandable field. You have to add $expand=HighlightedNotification in your request URI to get this field

": "{String}",
166
                    "notificationTypeLink
NotificationTypeLink

Notification type reference

This field is greyed out because it is an expandable field. You have to add $expand=HighlightedNotification in your request URI to get this field

": "{String}"
167
               },
168
               "notificationLink
NotificationLink

Notification reference

This field is greyed out because it is an expandable field. You have to add $expand=HighlightedNotification in your request URI to get this field

": "{String}"
169
          }
170
     }
171
}

Possible error codes the response might return:

Error 100051 HTTP 400 When logged in as supplier {0} you do not have access to this API resource
Error 100055 HTTP 403 You have only admittance to your own objects
Error 100001 HTTP 404 Address not found